v0.15.0: ruma-common 0.15.0

Compare Source

Breaking changes:

• #[serde(flatten)] on the only body field of a #[request] or #[response] struct is disallowed. #[ruma_api(body)] must be used instead.

Improvements:

• The ruma_identifiers_storage compile-time cfg setting can also be configured by setting the RUMA_IDENTIFIERS_STORAGE environment variable at compile time. It has the benefit of not requiring to re-compile all the crates of the dependency chain when the value is changed.
• The unstable-exhaustive-types cargo feature was replaced by the ruma_unstable_exhaustive_types compile-time cfg setting. Like all cfg settings, it can be enabled at compile-time with the RUSTFLAGS environment variable, or inside .cargo/config.toml. It can also be enabled by setting the RUMA_UNSTABLE_EXHAUSTIVE_TYPES environment variable.
• HttpPusherData allows to set custom data for the pusher in the data field, due to a clarification in the spec.
  • The default_payload field that was behind the unstable-unspecified was removed. It can be added manually to the custom data.

v0.14.1: ruma-common 0.14.1

Compare Source

Bug fixes:

• The KeyId::key_name method now returns the key name. In 0.14.0, key_name mistakenly returned the algorithm.

v0.14.0: ruma-common 0.14.0

Compare Source

Bug fixes:

• The instance_id field was removed from ProtocolInstanceInit and is now an Option<String> for ProtocolInstance. It made the unstable-unspecified feature non-additive.

Breaking changes:

• Rename the query_map attribute of the request macro to query_all, and remove the required bound to implement IntoIterator<Item = (String, String)>. This allows to use a struct or enum as well as a map to represent the list of query parameters. Note that the (de)serialization of the type used must work with serde_html_form.
• The header attribute for the request and response macros accepts any type that implements ToString and FromStr.
• The compat-key-id cargo feature was renamed to compat-server-signing-key-version.
• (Owned)KeyName was renamed to (Owned)ServerSigningKeyVersion and is now validated according to the set of allowed characters defined in the docs, unless the compat-server-signing-key-version cargo feature is enabled.
• The bounds on KeyId changed. The algorithm part must implement KeyAlgorithm and the key name part must implement KeyName.
• The (owned_)server_signing_key_id macros were removed. For compile-time validated construction, use ServerSigningKeyId::from_parts with a SigningKeyAlgorithm and the server_signing_key_version macro.
• Rename Signatures::insert to Signatures::insert_signature. Signatures::insert is now dereferenced to BTreeMap::insert.
• Move the DeviceKeyAlgorithm::SignedCurve25519 into the new OneTimeKeyAlgorithm type.
• Add (Owned)CrossSigningKeyId and use it instead of OwnedDeviceKeyId to identify CrossSigningKey's keys.
• Add (Owned)CrossSigningOrDeviceSigningKeyId and use it instead of OwnedDeviceKeyId to identify signing keys in DeviceKeys's and CrossSigningKey's signatures.
• Use OwnedDeviceSigningKeyId instead of OwnedDeviceKeyId to identify signing keys in SignedKey's signatures.
• (Owned)DeviceKeyId is now a type alias of (Owned)KeyId.
  • Remove the (owned_)device_key_id macro, instead use DeviceKeyId::from_parts.
• Use CrossSigningOrDeviceSignatures for the signatures of DeviceKeys.
• Remove SignedKeySignatures and replace it with DeviceSignatures.
• Remove CrossSigningKeySignatures and replace it with CrossSigningOrDeviceSignatures.

Improvements:

• Add the InvalidHeaderValue variant to the DeserializationError struct, for cases where we receive a HTTP header with an unexpected value.
• Implement Eq/Hash/PartialEq for ThirdPartyIdentifier, to check whether a ThirdPartyIdentifier has already been added by another user.
• Add MatrixVersion::V1_11 and MatrixVersion::V1_12.
• Clarify in the docs of AuthScheme that sending an access token via a query parameter is deprecated, according to MSC4126 / Matrix 1.11.
• Constructing a Matrix URI for an event with a room alias is deprecated, according to MSC4132 / Matrix 1.11
• Implement Eq and PartialEq for Metadata
• Allow constructing api::error::MatrixErrorBody::NotJson outside of this crate.
• Improve the API of Signatures, by implementing Deref and DerefMut, as well as From, Extend and FromIterator from a list of (entity, key_identifier, value) tuples.
• Add (Owned)OneTimeKeyId and (Owned)OneTimeKeyName to identify one-time and fallback keys instead of using (Owned)DeviceKeyId.
• Add (Owned)Base64PublicKey and (Owned)Base64PublicKeyOrDeviceId to identify cross-signing keys.
  • Add (owned_)base_64_public_key to construct a compile-time validated (Owned)Base64PublicKey.